FoxitPDFSDKPython3.SchemaField类 参考
类 FoxitPDFSDKPython3.SchemaField 继承关系图:
Public 成员函数 | |
| def | SchemaField () |
| 构造函数。 | |
| def | SchemaField (other) |
| 构造函数，使用另一个架构字段对象。 更多... | |
| def | GetDisplayName () |
| 获取显示名称。 更多... | |
| def | GetKeyName () |
| 获取键名字符串。 更多... | |
| def | GetSubtypeName () |
| 获取子类型名称字符串。 更多... | |
| def | IsEmpty () |
| 检查当前对象是否为空。 更多... | |
| def | IsVisible () |
| 检查当前字段在应用程序中是否初始可见。 更多... | |
| def | SetDisplayName (display_name) |
| 设置显示名称。 更多... | |
| def | SetKeyName (key_name) |
| 设置键名字符串。 更多... | |
| def | SetSubtypeName (subtype_name) |
| 设置子类型名称字符串。 更多... | |
| def | SetVisibility (is_visible) |
| 设置当前字段在应用程序中的初始可见性。 更多... | |
详细描述
架构字段可用于决定在应用程序中显示或隐藏节点的哪些信息。
构造及析构函数说明
◆ SchemaField()
| def FoxitPDFSDKPython3.SchemaField.SchemaField | ( | other | ) |
构造函数，使用另一个架构字段对象。
- 参数
-
[in] other 另一个PDF作品集文件夹对象。
成员函数说明
◆ GetDisplayName()
| def FoxitPDFSDKPython3.SchemaField.GetDisplayName | ( | ) |
获取显示名称。
显示名称用于显示。这可以与架构字段的键名不同。
- 返回
- 显示名称字符串。
◆ GetKeyName()
| def FoxitPDFSDKPython3.SchemaField.GetKeyName | ( | ) |
获取键名字符串。
每个架构字段都通过唯一的键名存储。 架构字段的键名可用于：
-
作为类 Portfolio 中排序的字段名。
-
当架构字段的子类型表示数据类型时，作为文件或文件夹节点字典中条目的键名。
- 返回
- 键名字符串。
◆ GetSubtypeName()
| def FoxitPDFSDKPython3.SchemaField.GetSubtypeName | ( | ) |
获取子类型名称字符串。
子类型名称可用于直接指定文件节点和文件夹节点的某些属性：
-
"F"，表示嵌入文件的文件名或文件夹节点的名称。
-
"Desc"，表示嵌入文件的描述或文件夹节点的描述。
-
"ModDate"，表示嵌入文件的修改日期或文件夹节点的描述。
-
"CreationDate"，表示嵌入文件的创建日期或文件夹节点的描述。
-
"Size"，表示嵌入文件的未压缩大小；文件夹节点没有大小。
-
"CompressedSize"，表示嵌入文件的压缩大小；文件夹节点没有压缩大小。
对于其他情况，子类型名称用于指定文件或文件夹节点字典中指定条目的数据类型。 条目的键由当前架构字段的键名指定，数据类型通过以下方式指定：
-
"S"，表示字段数据应存储为PDF文本字符串。
-
"D", means the field data shall be stored as a PDF date string.
-
"N", means the field data shall be stored as a PDF number.
- 返回
- 子类型名称字符串。
◆ IsEmpty()
| def FoxitPDFSDKPython3.SchemaField.IsEmpty | ( | ) |
检查当前对象是否为空。
当前对象为空时，表示当前对象无用。
- 返回
- true 表示当前对象为空，false 表示不为空。
◆ IsVisible()
| def FoxitPDFSDKPython3.SchemaField.IsVisible | ( | ) |
检查当前字段在应用程序中是否初始可见。
- 返回
- true 表示当前字段在应用程序中初始可见， false 表示当前字段在应用程序中初始不可见。
◆ SetDisplayName()
| def FoxitPDFSDKPython3.SchemaField.SetDisplayName | ( | display_name | ) |
设置显示名称。
显示名称用于显示。这可以与架构字段的键名不同。
- 参数
-
[in] display_name 显示名称字符串。不应为空字符串。
- 返回
- 无。
◆ SetKeyName()
| def FoxitPDFSDKPython3.SchemaField.SetKeyName | ( | key_name | ) |
设置键名字符串。
每个架构字段都通过唯一的键名存储。 架构字段的键名可用于：
-
作为类 Portfolio 中排序的字段名。
-
当架构字段的子类型表示数据类型时，作为文件或文件夹节点字典中条目的键名。
- 参数
-
[in] key_name 新的键名字符串。不应为空字符串。
- 返回
- 无。
◆ SetSubtypeName()
| def FoxitPDFSDKPython3.SchemaField.SetSubtypeName | ( | subtype_name | ) |
设置子类型名称字符串。
子类型名称可用于直接指定文件节点和文件夹节点的某些属性：
-
"F"，表示嵌入文件的文件名或文件夹节点的名称。
-
"Desc"，表示嵌入文件的描述或文件夹节点的描述。
-
"ModDate"，表示嵌入文件的修改日期或文件夹节点的描述。
-
"CreationDate"，表示嵌入文件的创建日期或文件夹节点的描述。
-
"Size"，表示嵌入文件的未压缩大小；文件夹节点没有大小。
-
"CompressedSize"，表示嵌入文件的压缩大小；文件夹节点没有压缩大小。
对于其他情况，子类型名称用于指定文件或文件夹节点字典中指定条目的数据类型。 条目的键由当前架构字段的键名指定，数据类型通过以下方式指定：
-
"S"，表示字段数据应存储为PDF文本字符串。
-
"D"，表示字段数据应存储为PDF日期字符串。
-
"N"，表示字段数据应存储为PDF数字。
- 参数
-
[in] subtype_name 子类型名称字符串。不应为空字符串。 更多信息请参考"详细说明"部分。
- 返回
- 无。
◆ SetVisibility()
| def FoxitPDFSDKPython3.SchemaField.SetVisibility | ( | is_visible | ) |
设置当前字段在应用程序中的初始可见性。
- 参数
-
[in] is_visible true 表示当前字段在应用程序中初始可见， false 表示当前字段在应用程序中初始不可见。
- 返回
- 无。
